From 0c4772f3d407ca46a249e5a493bd9b067ba6d272 Mon Sep 17 00:00:00 2001 From: parkrrrr Date: Fri, 19 May 2006 20:04:30 +0000 Subject: [PATCH] formats: Added descriptive text for the few remaining undocumented formats formats/options: Documented various options (mostly with the awesome power of 'cp'.) --- gpsbabel/xmldoc/formats/arc.xml | 6 ++++++ gpsbabel/xmldoc/formats/custom.xml | 10 +++++++++- gpsbabel/xmldoc/formats/options/cetus-appendicon.xml | 8 +++++++- gpsbabel/xmldoc/formats/options/cetus-dbname.xml | 5 +++++ gpsbabel/xmldoc/formats/options/geoniche-dbname.xml | 5 +++++ gpsbabel/xmldoc/formats/options/gpilots-dbname.xml | 5 +++++ gpsbabel/xmldoc/formats/options/gpspilot-dbname.xml | 5 +++++ gpsbabel/xmldoc/formats/options/gpx-gpxver.xml | 5 +++++ gpsbabel/xmldoc/formats/options/pathaway-dbname.xml | 5 +++++ gpsbabel/xmldoc/formats/options/quovadis-dbname.xml | 5 +++++ gpsbabel/xmldoc/formats/tabsep.xml | 12 ++++++++++++ gpsbabel/xmldoc/formats/xcsv.xml | 12 ++++++++++++ 12 files changed, 81 insertions(+), 2 deletions(-) diff --git a/gpsbabel/xmldoc/formats/arc.xml b/gpsbabel/xmldoc/formats/arc.xml index e69de29bb..a10c27ad1 100644 --- a/gpsbabel/xmldoc/formats/arc.xml +++ b/gpsbabel/xmldoc/formats/arc.xml @@ -0,0 +1,6 @@ + +This format is used by GPSBabel itself as the input to the +arc and +polygon filters. See those filters +for more information. + diff --git a/gpsbabel/xmldoc/formats/custom.xml b/gpsbabel/xmldoc/formats/custom.xml index 8b1378917..40cbece72 100644 --- a/gpsbabel/xmldoc/formats/custom.xml +++ b/gpsbabel/xmldoc/formats/custom.xml @@ -1 +1,9 @@ - + +This format is not actually used by any real product. It is most useful +for debugging purposes when developing a new format module for GPSBabel. + + +To understand the contents of this file, look at the +style/custom.style file in the GPSBabel source +distribution as well as the appendix. + diff --git a/gpsbabel/xmldoc/formats/options/cetus-appendicon.xml b/gpsbabel/xmldoc/formats/options/cetus-appendicon.xml index 8b1378917..9a52e4eef 100644 --- a/gpsbabel/xmldoc/formats/options/cetus-appendicon.xml +++ b/gpsbabel/xmldoc/formats/options/cetus-appendicon.xml @@ -1 +1,7 @@ - + +This option will add the icon description to the end of the waypoint +description on output. This can be useful if the icon is used to convey +important information about the waypoint. For example, the icon might be +"found geocache" or "unfound geocache"; it might be useful to know that when +looking at a list of icons in Cetus. + diff --git a/gpsbabel/xmldoc/formats/options/cetus-dbname.xml b/gpsbabel/xmldoc/formats/options/cetus-dbname.xml index 8b1378917..f4b336e5e 100644 --- a/gpsbabel/xmldoc/formats/options/cetus-dbname.xml +++ b/gpsbabel/xmldoc/formats/options/cetus-dbname.xml @@ -1 +1,6 @@ + +This option specifies the database name for the output file. This name is +not the same thing as the file name on your computer; this is the name that +appears in the file browser on your handheld. + diff --git a/gpsbabel/xmldoc/formats/options/geoniche-dbname.xml b/gpsbabel/xmldoc/formats/options/geoniche-dbname.xml index 8b1378917..f4b336e5e 100644 --- a/gpsbabel/xmldoc/formats/options/geoniche-dbname.xml +++ b/gpsbabel/xmldoc/formats/options/geoniche-dbname.xml @@ -1 +1,6 @@ + +This option specifies the database name for the output file. This name is +not the same thing as the file name on your computer; this is the name that +appears in the file browser on your handheld. + diff --git a/gpsbabel/xmldoc/formats/options/gpilots-dbname.xml b/gpsbabel/xmldoc/formats/options/gpilots-dbname.xml index 8b1378917..f4b336e5e 100644 --- a/gpsbabel/xmldoc/formats/options/gpilots-dbname.xml +++ b/gpsbabel/xmldoc/formats/options/gpilots-dbname.xml @@ -1 +1,6 @@ + +This option specifies the database name for the output file. This name is +not the same thing as the file name on your computer; this is the name that +appears in the file browser on your handheld. + diff --git a/gpsbabel/xmldoc/formats/options/gpspilot-dbname.xml b/gpsbabel/xmldoc/formats/options/gpspilot-dbname.xml index 8b1378917..f4b336e5e 100644 --- a/gpsbabel/xmldoc/formats/options/gpspilot-dbname.xml +++ b/gpsbabel/xmldoc/formats/options/gpspilot-dbname.xml @@ -1 +1,6 @@ + +This option specifies the database name for the output file. This name is +not the same thing as the file name on your computer; this is the name that +appears in the file browser on your handheld. + diff --git a/gpsbabel/xmldoc/formats/options/gpx-gpxver.xml b/gpsbabel/xmldoc/formats/options/gpx-gpxver.xml index 8b1378917..4571bd7fb 100644 --- a/gpsbabel/xmldoc/formats/options/gpx-gpxver.xml +++ b/gpsbabel/xmldoc/formats/options/gpx-gpxver.xml @@ -1 +1,6 @@ + +This option specifies the version of the GPX specification to use for +output. The default version is 1.0. The only other valid value for this +option is 1.1. + diff --git a/gpsbabel/xmldoc/formats/options/pathaway-dbname.xml b/gpsbabel/xmldoc/formats/options/pathaway-dbname.xml index 8b1378917..f4b336e5e 100644 --- a/gpsbabel/xmldoc/formats/options/pathaway-dbname.xml +++ b/gpsbabel/xmldoc/formats/options/pathaway-dbname.xml @@ -1 +1,6 @@ + +This option specifies the database name for the output file. This name is +not the same thing as the file name on your computer; this is the name that +appears in the file browser on your handheld. + diff --git a/gpsbabel/xmldoc/formats/options/quovadis-dbname.xml b/gpsbabel/xmldoc/formats/options/quovadis-dbname.xml index 8b1378917..f4b336e5e 100644 --- a/gpsbabel/xmldoc/formats/options/quovadis-dbname.xml +++ b/gpsbabel/xmldoc/formats/options/quovadis-dbname.xml @@ -1 +1,6 @@ + +This option specifies the database name for the output file. This name is +not the same thing as the file name on your computer; this is the name that +appears in the file browser on your handheld. + diff --git a/gpsbabel/xmldoc/formats/tabsep.xml b/gpsbabel/xmldoc/formats/tabsep.xml index 8b1378917..42c6c1136 100644 --- a/gpsbabel/xmldoc/formats/tabsep.xml +++ b/gpsbabel/xmldoc/formats/tabsep.xml @@ -1 +1,13 @@ + +This format, like the custom format, is +mainly used for the purpose of testing GPSBabel. It is supposed to contain +one field for each piece of information supported by the +xcsv format writer, but it may not be entirely +in sync with the appendix that describes +those fields. + + +For a list of fields, see the style/tabsep.style file in the GPSBabel source +distribution. + diff --git a/gpsbabel/xmldoc/formats/xcsv.xml b/gpsbabel/xmldoc/formats/xcsv.xml index 8b1378917..5b695d793 100644 --- a/gpsbabel/xmldoc/formats/xcsv.xml +++ b/gpsbabel/xmldoc/formats/xcsv.xml @@ -1 +1,13 @@ + +This format is a very flexible module that can be used to read or write +nearly any plain-text record-based waypoint file. This flexibility is +achieved with "style" files that describe the format of the waypoint files. + + +There are several formats built in to GPSBabel that use the underlying xcsv +machinery. Each of those formats takes the same options as the xcsv format, +with the obvious exception of the option. +Those formats are all based on style files that can be found in +the "style" directory in the GPSBabel source distribution. + -- 2.30.2